<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>DynamoDbResultsPage | @aws/dynamodb-query-iterator</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@aws/dynamodb-query-iterator</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="dynamodbresultspage.html">DynamoDbResultsPage</a>
				</li>
			</ul>
			<h1>Interface DynamoDbResultsPage</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">DynamoDbResultsPage</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dynamodbresultspage.html#consumedcapacity" class="tsd-kind-icon">Consumed<wbr>Capacity</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dynamodbresultspage.html#count" class="tsd-kind-icon">Count</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dynamodbresultspage.html#items" class="tsd-kind-icon">Items</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dynamodbresultspage.html#lastevaluatedkey" class="tsd-kind-icon">Last<wbr>Evaluated<wbr>Key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="dynamodbresultspage.html#scannedcount" class="tsd-kind-icon">Scanned<wbr>Count</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="consumedcapacity" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> Consumed<wbr>Capacity</h3>
					<div class="tsd-signature tsd-kind-icon">Consumed<wbr>Capacity<span class="tsd-signature-symbol">:</span> <a href="dynamodbresultspage.html#consumedcapacity" class="tsd-signature-type">ConsumedCapacity</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-query-iterator/src/DynamoDbResultsPage.ts#L50">DynamoDbResultsPage.ts:50</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The capacity units consumed by the operation. The data returned includes
								the total provisioned throughput consumed, along with statistics for the
								table and any indexes involved in the operation. ConsumedCapacity is only
								returned if the ReturnConsumedCapacity parameter was specified For more
								information, see Provisioned Throughput in the Amazon DynamoDB Developer
							Guide.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="count" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> Count</h3>
					<div class="tsd-signature tsd-kind-icon">Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-query-iterator/src/DynamoDbResultsPage.ts#L20">DynamoDbResultsPage.ts:20</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The number of items in the response. If you used a filter in the request,
								then Count is the number of items returned after the filter was applied,
								and ScannedCount is the number of matching items before the filter was
								applied. If you did not use a filter in the request, then Count and
							ScannedCount are the same.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="items" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> Items</h3>
					<div class="tsd-signature tsd-kind-icon">Items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AttributeMap</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-query-iterator/src/DynamoDbResultsPage.ts#L11">DynamoDbResultsPage.ts:11</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>An array of retrieved items.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="lastevaluatedkey" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> Last<wbr>Evaluated<wbr>Key</h3>
					<div class="tsd-signature tsd-kind-icon">Last<wbr>Evaluated<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Key</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-query-iterator/src/DynamoDbResultsPage.ts#L40">DynamoDbResultsPage.ts:40</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The primary key of the item where the operation stopped, inclusive of the
								previous result set. Use this value to start a new operation, excluding
								this value in the new request. If LastEvaluatedKey is empty, then the
								&quot;last page&quot; of results has been processed and there is no more data to be
								retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean
								that there is more data in the result set. The only way to know when you
							have reached the end of the result set is when LastEvaluatedKey is empty.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="scannedcount" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> Scanned<wbr>Count</h3>
					<div class="tsd-signature tsd-kind-icon">Scanned<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-query-iterator/src/DynamoDbResultsPage.ts#L29">DynamoDbResultsPage.ts:29</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The number of items evaluated, before any filter is applied. A high
								ScannedCount value with few, or no, Count results indicates an
								inefficient operation. For more information, see Count and ScannedCount
								in the Amazon DynamoDB Developer Guide. If you did not use a filter in
							the request, then ScannedCount is the same as Count.</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="../classes/dynamodbpaginator.html" class="tsd-kind-icon">Dynamo<wbr>DbPaginator</a>
					</li>
					<li class=" tsd-kind-class tsd-has-type-parameter">
						<a href="../classes/itemiterator.html" class="tsd-kind-icon">Item<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/parallelscaniterator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/parallelscanpaginator.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/queryiterator.html" class="tsd-kind-icon">Query<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/querypaginator.html" class="tsd-kind-icon">Query<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/scaniterator.html" class="tsd-kind-icon">Scan<wbr>Iterator</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="../classes/scanpaginator.html" class="tsd-kind-icon">Scan<wbr>Paginator</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="dynamodbpaginatorinterface.html" class="tsd-kind-icon">Dynamo<wbr>DbPaginator<wbr>Interface</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface">
						<a href="dynamodbresultspage.html" class="tsd-kind-icon">Dynamo<wbr>DbResults<wbr>Page</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="dynamodbresultspage.html#consumedcapacity" class="tsd-kind-icon">Consumed<wbr>Capacity</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="dynamodbresultspage.html#count" class="tsd-kind-icon">Count</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="dynamodbresultspage.html#items" class="tsd-kind-icon">Items</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="dynamodbresultspage.html#lastevaluatedkey" class="tsd-kind-icon">Last<wbr>Evaluated<wbr>Key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="dynamodbresultspage.html#scannedcount" class="tsd-kind-icon">Scanned<wbr>Count</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-interface">
						<a href="initializedscanstate.html" class="tsd-kind-icon">Initialized<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="parallelscaninput.html" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>Input</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="uninitializedscanstate.html" class="tsd-kind-icon">Uninitialized<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="../globals.html#parallelscanstate" class="tsd-kind-icon">Parallel<wbr>Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="../globals.html#scanstate" class="tsd-kind-icon">Scan<wbr>State</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="../globals.html#mergeconsumedcapacities" class="tsd-kind-icon">merge<wbr>Consumed<wbr>Capacities</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>